Create Authorization Journey 1

This page will guide you through the authorization requests used by journey 1

Authorization request for recurring payment

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations'

Headers

Name	Description
Authorization	Required. API key
idempotencyKey	Required. Guid

Body

Name	Type	Description
recurrenceId	string	Optional. Identifier of the recurrence
frequencyType	enum	Required. Frequency type. Domains: WEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY
recurrenceStartDate	string	Required. Start date of the recurrence
recurrenceEndDate	string	Optional. End date of the recurrence
amount	number	Optional. Transaction amount
minPayerMaxAmount	number	Optional. Minimum allowed for payer's max amount
beneficiary	object	Required. Object containing all the info about the beneficiary
beneficiary.ispb	string	Required. ISPB code of the beneficiary
beneficiary.document	string	Required. Document of the beneficiary (CPF/CNPJ)
beneficiary.name	string	Required. Fullname of the beneficiary
beneficiary.agencyNumber	string	Optional. Beneficiary agency number
beneficiary.accountType	enum	Optional. Beneficiary account type. Domains: CURRENT, WAGE, SAVINGS, PAYMENT
beneficiary.accountNumber	string	Optional. Beneficiary account number
payer	object	Required. Object containing all the info about the payer
payer.ispb	string	Required. ISPB code of the payer
payer.type	enum	Required. Type of the payer's document. Domains: NATURAL - Natural Person LEGAL - Legal Person
payer.document	string	Required. Document of the payer (CPF/CNPJ)
payer.name	string	Optional. Fullname of the payer
payer.agencyNumber	string	Optional. Payer agency number
payer.accountType	enum	Optional. Payer account type. Domains: CURRENT, WAGE, SAVINGS, PAYMENT
payer.accountNumber	string	Optional. Payer account number
payer.municipalityIbgeCode	number	Optional. Payer's municipality IBGE code
debtor	object	Optional. Object containing all the info about the debtor
debtor.type	enum	Required. Type of the debtor's document. Domains: NATURAL - Natural Person LEGAL - Legal Person
debtor.document	string	Required. Document of the debtor (CPF/CNPJ)
debtor.name	string	Required. Fullname of the debtor
contractNumber	string	Required. Contract number
contractDescription	string	Optional. Description of the contract
requestExpiresAt	string	Required. Request expiration date/time

{
  "recurrenceId": "RR3822485720250711nDNIOOcVSOr",
  "frequencyType": "MONTHLY",
  "recurrenceStartDate": "2025-06-29",
  "recurrenceEndDate": "2026-06-29",
  "amount": 150.75,
  "minPayerMaxAmount": 150.75,
  "beneficiary": {
    "ispb": "38224857",
    "document": "12345678901",
    "name": "Fulano Ciclano",
    "agencyNumber": "0001",
    "accountType": "CURRENT",
    "accountNumber": "31747"
  },
  "payer": {
    "ispb": "38224857",
    "type": "NATURAL",
    "document": "07161543584",
    "name": "Beltrano",
    "agencyNumber": "0001",
    "accountType": "CURRENT",
    "accountNumber": "12345"
  },
  "debtor": {
    "type": "NATURAL",
    "document": "07161543584",
    "name": "Beltrano"
  },
  "contractNumber": "CONTRATO123",
  "contractDescription": "Assinatura Premium",
  "requestExpiresAt": "2025-06-15T12:05:00.000Z"
}

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
    "recurrenceId": "RR3822485720250711nDNIOOcVSOr",
    "requestAt": "2025-07-11T15:39:12.054"
}